Esx Settings Clusters InstalledImages InstalledImageInfo

Esx Settings Clusters InstalledImages InstalledImageInfo
Esx Settings Clusters InstalledImages InstalledImageInfo

The Esx Settings Clusters InstalledImages InstalledImageInfo schema contains properties describing software image running on hosts underneath the cluster and its relevant metadata.

This schema was added in vSphere API 8.0.3.0.

JSON Example
{
    "completion_time": "string",
    "uniform_image": false,
    "status": "string",
    "successful_hosts": [
        "string"
    ],
    "failed_hosts": [
        "string"
    ],
    "unsupported_hosts": [
        "string"
    ],
    "image_categories": {
        "is_highest_and_widely_used_image_equal": false,
        "most_widely_used_image": {
            "software_info": {
                "base_image": {
                    "details": {
                        "display_name": "string",
                        "display_version": "string",
                        "release_date": "string",
                        "quick_patch_compatible_versions": {
                            "quick_patch_compatible_versions": "string"
                        }
                    },
                    "version": "string"
                },
                "add_on": {
                    "details": {
                        "display_name": "string",
                        "vendor": "string",
                        "display_version": "string"
                    },
                    "name": "string",
                    "version": "string"
                },
                "components": {
                    "components": {
                        "version": "string",
                        "details": {
                            "display_name": "string",
                            "vendor": "string",
                            "display_version": "string"
                        }
                    }
                },
                "solutions": {
                    "solutions": {
                        "details": {
                            "display_name": "string",
                            "display_version": "string",
                            "components": [
                                {
                                    "component": "string",
                                    "display_name": "string",
                                    "display_version": "string",
                                    "vendor": "string"
                                }
                            ]
                        },
                        "version": "string",
                        "components": [
                            {
                                "component": "string"
                            }
                        ]
                    }
                },
                "hardware_support": {
                    "packages": {
                        "packages": {
                            "pkg": "string",
                            "version": "string"
                        }
                    }
                },
                "removed_components": {
                    "removed_components": {
                        "version": "string",
                        "details": {
                            "display_name": "string",
                            "vendor": "string",
                            "display_version": "string"
                        }
                    }
                },
                "alternative_images": {
                    "alternative_images": {
                        "base_image": {
                            "details": {
                                "display_name": "string",
                                "display_version": "string",
                                "release_date": "string",
                                "quick_patch_compatible_versions": {
                                    "quick_patch_compatible_versions": "string"
                                }
                            },
                            "version": "string"
                        },
                        "add_on": {
                            "details": {
                                "display_name": "string",
                                "vendor": "string",
                                "display_version": "string"
                            },
                            "name": "string",
                            "version": "string"
                        },
                        "components": {
                            "components": {
                                "version": "string",
                                "details": {
                                    "display_name": "string",
                                    "vendor": "string",
                                    "display_version": "string"
                                }
                            }
                        },
                        "solutions": {
                            "solutions": {
                                "details": {
                                    "display_name": "string",
                                    "display_version": "string",
                                    "components": [
                                        {
                                            "component": "string",
                                            "display_name": "string",
                                            "display_version": "string",
                                            "vendor": "string"
                                        }
                                    ]
                                },
                                "version": "string",
                                "components": [
                                    {
                                        "component": "string"
                                    }
                                ]
                            }
                        },
                        "hardware_support": {
                            "packages": {
                                "packages": {
                                    "pkg": "string",
                                    "version": "string"
                                }
                            }
                        },
                        "removed_components": {
                            "removed_components": {
                                "version": "string",
                                "details": {
                                    "display_name": "string",
                                    "vendor": "string",
                                    "display_version": "string"
                                }
                            }
                        },
                        "display_name": "string",
                        "selection_criteria": {
                            "selection_type": "string",
                            "host_uuids": [
                                "string"
                            ],
                            "host_hardware_spec": {
                                "vendor": "string",
                                "models": [
                                    "string"
                                ],
                                "families": [
                                    "string"
                                ],
                                "oem_strings": [
                                    "string"
                                ]
                            }
                        }
                    }
                }
            },
            "host_list": [
                "string"
            ]
        },
        "highest_versioned_image": {
            "software_info": {
                "base_image": {
                    "details": {
                        "display_name": "string",
                        "display_version": "string",
                        "release_date": "string",
                        "quick_patch_compatible_versions": {
                            "quick_patch_compatible_versions": "string"
                        }
                    },
                    "version": "string"
                },
                "add_on": {
                    "details": {
                        "display_name": "string",
                        "vendor": "string",
                        "display_version": "string"
                    },
                    "name": "string",
                    "version": "string"
                },
                "components": {
                    "components": {
                        "version": "string",
                        "details": {
                            "display_name": "string",
                            "vendor": "string",
                            "display_version": "string"
                        }
                    }
                },
                "solutions": {
                    "solutions": {
                        "details": {
                            "display_name": "string",
                            "display_version": "string",
                            "components": [
                                {
                                    "component": "string",
                                    "display_name": "string",
                                    "display_version": "string",
                                    "vendor": "string"
                                }
                            ]
                        },
                        "version": "string",
                        "components": [
                            {
                                "component": "string"
                            }
                        ]
                    }
                },
                "hardware_support": {
                    "packages": {
                        "packages": {
                            "pkg": "string",
                            "version": "string"
                        }
                    }
                },
                "removed_components": {
                    "removed_components": {
                        "version": "string",
                        "details": {
                            "display_name": "string",
                            "vendor": "string",
                            "display_version": "string"
                        }
                    }
                },
                "alternative_images": {
                    "alternative_images": {
                        "base_image": {
                            "details": {
                                "display_name": "string",
                                "display_version": "string",
                                "release_date": "string",
                                "quick_patch_compatible_versions": {
                                    "quick_patch_compatible_versions": "string"
                                }
                            },
                            "version": "string"
                        },
                        "add_on": {
                            "details": {
                                "display_name": "string",
                                "vendor": "string",
                                "display_version": "string"
                            },
                            "name": "string",
                            "version": "string"
                        },
                        "components": {
                            "components": {
                                "version": "string",
                                "details": {
                                    "display_name": "string",
                                    "vendor": "string",
                                    "display_version": "string"
                                }
                            }
                        },
                        "solutions": {
                            "solutions": {
                                "details": {
                                    "display_name": "string",
                                    "display_version": "string",
                                    "components": [
                                        {
                                            "component": "string",
                                            "display_name": "string",
                                            "display_version": "string",
                                            "vendor": "string"
                                        }
                                    ]
                                },
                                "version": "string",
                                "components": [
                                    {
                                        "component": "string"
                                    }
                                ]
                            }
                        },
                        "hardware_support": {
                            "packages": {
                                "packages": {
                                    "pkg": "string",
                                    "version": "string"
                                }
                            }
                        },
                        "removed_components": {
                            "removed_components": {
                                "version": "string",
                                "details": {
                                    "display_name": "string",
                                    "vendor": "string",
                                    "display_version": "string"
                                }
                            }
                        },
                        "display_name": "string",
                        "selection_criteria": {
                            "selection_type": "string",
                            "host_uuids": [
                                "string"
                            ],
                            "host_hardware_spec": {
                                "vendor": "string",
                                "models": [
                                    "string"
                                ],
                                "families": [
                                    "string"
                                ],
                                "oem_strings": [
                                    "string"
                                ]
                            }
                        }
                    }
                }
            },
            "host_list": [
                "string"
            ]
        },
        "host_image_list": [
            {
                "software_info": {
                    "base_image": {
                        "details": {
                            "display_name": "string",
                            "display_version": "string",
                            "release_date": "string",
                            "quick_patch_compatible_versions": {
                                "quick_patch_compatible_versions": "string"
                            }
                        },
                        "version": "string"
                    },
                    "add_on": {
                        "details": {
                            "display_name": "string",
                            "vendor": "string",
                            "display_version": "string"
                        },
                        "name": "string",
                        "version": "string"
                    },
                    "components": {
                        "components": {
                            "version": "string",
                            "details": {
                                "display_name": "string",
                                "vendor": "string",
                                "display_version": "string"
                            }
                        }
                    },
                    "solutions": {
                        "solutions": {
                            "details": {
                                "display_name": "string",
                                "display_version": "string",
                                "components": [
                                    {
                                        "component": "string",
                                        "display_name": "string",
                                        "display_version": "string",
                                        "vendor": "string"
                                    }
                                ]
                            },
                            "version": "string",
                            "components": [
                                {
                                    "component": "string"
                                }
                            ]
                        }
                    },
                    "hardware_support": {
                        "packages": {
                            "packages": {
                                "pkg": "string",
                                "version": "string"
                            }
                        }
                    },
                    "removed_components": {
                        "removed_components": {
                            "version": "string",
                            "details": {
                                "display_name": "string",
                                "vendor": "string",
                                "display_version": "string"
                            }
                        }
                    },
                    "alternative_images": {
                        "alternative_images": {
                            "base_image": {
                                "details": {
                                    "display_name": "string",
                                    "display_version": "string",
                                    "release_date": "string",
                                    "quick_patch_compatible_versions": {
                                        "quick_patch_compatible_versions": "string"
                                    }
                                },
                                "version": "string"
                            },
                            "add_on": {
                                "details": {
                                    "display_name": "string",
                                    "vendor": "string",
                                    "display_version": "string"
                                },
                                "name": "string",
                                "version": "string"
                            },
                            "components": {
                                "components": {
                                    "version": "string",
                                    "details": {
                                        "display_name": "string",
                                        "vendor": "string",
                                        "display_version": "string"
                                    }
                                }
                            },
                            "solutions": {
                                "solutions": {
                                    "details": {
                                        "display_name": "string",
                                        "display_version": "string",
                                        "components": [
                                            {
                                                "component": "string",
                                                "display_name": "string",
                                                "display_version": "string",
                                                "vendor": "string"
                                            }
                                        ]
                                    },
                                    "version": "string",
                                    "components": [
                                        {
                                            "component": "string"
                                        }
                                    ]
                                }
                            },
                            "hardware_support": {
                                "packages": {
                                    "packages": {
                                        "pkg": "string",
                                        "version": "string"
                                    }
                                }
                            },
                            "removed_components": {
                                "removed_components": {
                                    "version": "string",
                                    "details": {
                                        "display_name": "string",
                                        "vendor": "string",
                                        "display_version": "string"
                                    }
                                }
                            },
                            "display_name": "string",
                            "selection_criteria": {
                                "selection_type": "string",
                                "host_uuids": [
                                    "string"
                                ],
                                "host_hardware_spec": {
                                    "vendor": "string",
                                    "models": [
                                        "string"
                                    ],
                                    "families": [
                                        "string"
                                    ],
                                    "oem_strings": [
                                        "string"
                                    ]
                                }
                            }
                        }
                    }
                },
                "host_list": [
                    "string"
                ]
            }
        ]
    },
    "host_notifications": {
        "host_notifications": {
            "info": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ],
            "warnings": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ],
            "errors": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ]
        }
    },
    "host_info": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "orphaned_vibs": {
        "orphaned_vibs": [
            "string"
        ]
    },
    "notifications": {
        "notifications": {
            "info": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ],
            "warnings": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ],
            "errors": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "resolution": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "originator": "string",
                    "retriable": false
                }
            ]
        }
    }
}
string As date-time As date-time
completion_time
Required

Timestamp describing the completion of generate candidate image operation

This property was added in vSphere API 8.0.3.0.

boolean
uniform_image
Required

If this flag is set, it means all hosts in cluster are running the same software image. In this case, “mostWidelyUsedImage” and “highestVersionImage” of “imageCategories” will contain same software image as value and subsequently “isHighestAndWidelyUsedImageEqual” flag will also be set. If this flag is not set, then depending upon the software image running in hosts “imageCategories” fields will be filled.

This property was added in vSphere API 8.0.3.0.

string
status
Required

Execution status of the task. If it's not SUCCESS then the Esx Settings Clusters InstalledImages InstalledImageInfo.notifications property of this schema can be inspected for more information.

For more information see: Esx Settings Clusters InstalledImages InstalledImageInfo Status.

This property was added in vSphere API 8.0.3.0.

array of string
successful_hosts
Required

List of Hosts for which software image has extracted

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string
failed_hosts
Required

List of hosts for which no software image has extracted

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string
unsupported_hosts
Required

List of hosts that were skipped for extracting software image. Host will be skipped when software version is less than the supported version.

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

image_categories
Required

Various categories of software image running on hosts in the cluster

This property was added in vSphere API 8.0.3.0.

object
host_notifications
Required

Notifications stating any error or orphaned vibs etc on Hosts

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.

object
host_info
Required

Information about the hosts in this cluster for which checks have been requested to be run.

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.

object
orphaned_vibs
Required

Information about the orphaned vibs available on the hosts underlying cluster. Here Key is the orphaned vibs and value is the list of hosts where these orphaned vibs have installed. orphaned vibs formats are orphaned vibs name(version).

This property was added in vSphere API 8.0.3.0.

When clients pass a value of this schema as a parameter, the value in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the value in the property map will be an identifier for the resource type: HostSystem.

object
notifications
Required

Various notifications received and segregated based on operation type while generating the report. If the task's status is ELIGIBILITY_CHECK_FAILURE then the notifications corresponding to the ELIGIBILITY_CHECK key can be inspected for more informaiton. For any other task status the notifications corresponding to the EXTRACT_INSTALLED_IMAGE key can be inspected.

This property was added in vSphere API 8.0.3.0.